Z-Wave JS: Title-Case "S2 Access Control" #20850

AlCalzone · 2024-05-22T11:15:59Z

Breaking change

Proposed change

This PR changes "S2 access control" to "S2 Access Control" in the Z-Wave JS Add Node dialog. It was the only label that was not in title case and looked out of place.

Type of change

Dependency upgrade
Bugfix (non-breaking change which fixes an issue)
New feature (thank you!)
Breaking change (fix/feature causing existing functionality to break)
Code quality improvements to existing code or addition of tests

Example configuration

Additional information

This PR fixes or closes issue: fixes #
This PR is related to issue or discussion:
Link to documentation pull request:

Checklist

The code change is tested and works locally.
There is no commented out code in this PR.
Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated for www.home-assistant.io

Summary by CodeRabbit

Style
- Updated capitalization in titles and descriptions for consistency and clarity in the app's security systems and access control sections.

matthiasdebaat · 2024-05-22T11:36:58Z

From what I know we want to use sentence-style capitalization, based on the Microsoft Guidelines we follow.

AlCalzone · 2024-05-22T11:42:08Z

The 4 security classes are kind of like names, so I don't necessarily agree in this case.

However, we need to decide to do one or the other, because it looks odd right now:

piitaya · 2024-05-22T12:16:35Z

At least for description, Example: Lighting, Sensors and Security Systems should be Example: Lighting, sensors and security systems to be consistent with Home Assistant guidelines based on Microsoft guidelines and with others descriptions.
For title, as it's a Z-Wave thing, I'm not sure we have to follow guidelines. It must be the same a Z-WaveJS.

AlCalzone · 2024-05-22T16:04:19Z

We don't have to follow guidelines there, but most documentation around this and the specifications have the security classes in title case.
The same labels are also used on the device details page, so we should stay consistent whatever we do.

About the ecsmples I agree, those should be sentence case. I can include that in this PR.

src/translations/en.json

coderabbitai · 2024-05-24T13:13:37Z

Walkthrough

The recent changes focus on ensuring consistent capitalization in the titles and descriptions within the en.json translation file. Specifically, the titles related to security systems and access control have been updated to maintain uniformity and enhance readability. This involves adjusting the capitalization of certain words to align with standard conventions.

Changes

File	Change Summary
`src/translations/en.json`	Updated the capitalization in the description of `"S2_Authenticated"` and the title of `"S2_AccessControl"` for consistency.

Tip

New Features and Improvements

Review Settings

Introduced new personality profiles for code reviews. Users can now select between "Chill" and "Assertive" review tones to tailor feedback styles according to their preferences. The "Assertive" profile posts more comments and nitpicks the code more aggressively, while the "Chill" profile is more relaxed and posts fewer comments.

AST-based Instructions

CodeRabbit offers customizing reviews based on the Abstract Syntax Tree (AST) pattern matching. Read more about AST-based instructions in the documentation.

Community-driven AST-based Rules

We are kicking off a community-driven initiative to create and share AST-based rules. Users can now contribute their AST-based rules to detect security vulnerabilities, code smells, and anti-patterns. Please see the ast-grep-essentials repository for more information.

New Static Analysis Tools

We are continually expanding our support for static analysis tools. We have added support for biome, hadolint, and ast-grep. Update the settings in your .coderabbit.yaml file or head over to the settings page to enable or disable the tools you want to use.

Tone Settings

Users can now customize CodeRabbit to review code in the style of their favorite characters or personalities. Here are some of our favorite examples:

Mr. T: "You must talk like Mr. T in all your code reviews. I pity the fool who doesn't!"
Pirate: "Arr, matey! Ye must talk like a pirate in all yer code reviews. Yarrr!"
Snarky: "You must be snarky in all your code reviews. Snark, snark, snark!"

Revamped Settings Page

We have redesigned the settings page for a more intuitive layout, enabling users to find and adjust settings quickly. This change was long overdue; it not only improves the user experience but also allows our development team to add more settings in the future with ease. Going forward, the changes to .coderabbit.yaml will be reflected in the settings page, and vice versa.

Miscellaneous

Turn off free summarization: You can switch off free summarization of PRs opened by users not on a paid plan using the enable_free_tier setting.
Knowledge-base scope: You can now set the scope of the knowledge base to either the repository (local) or the organization (global) level using the knowledge_base setting. In addition, you can specify Jira project keys and Linear team keys to limit the knowledge base scope for those integrations.
High-level summary placement: You can now customize the location of the high-level summary in the PR description using the high_level_summary_placeholder setting (default @coderabbitai summary).
Revamped request changes workflow: You can now configure CodeRabbit to auto-approve or request changes on PRs based on the review feedback using the request_changes_workflow setting.

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between 2113cf5 and 95988ce.

Files selected for processing (1)

src/translations/en.json (1 hunks)

Additional comments not posted (2)

src/translations/en.json (2)

4873-4873: Change in description to sentence case aligns with Home Assistant's capitalization guidelines.

4876-4876: Title case for "S2 Access Control" is appropriate given the context of security classes being treated as proper nouns.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

Z-Wave JS: Title-Case "S2 Access Control"

5b55a4a

home-assistant bot added the cla-signed label May 22, 2024

piitaya previously approved these changes May 22, 2024

View reviewed changes

silamon reviewed May 24, 2024

View reviewed changes

src/translations/en.json Outdated Show resolved Hide resolved

Apply sentence case to example description

95988ce

silamon dismissed piitaya’s stale review via 95988ce May 24, 2024 13:13

silamon approved these changes May 24, 2024

View reviewed changes

silamon enabled auto-merge (squash) May 24, 2024 13:14

silamon merged commit 0991628 into home-assistant:dev May 24, 2024
9 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Z-Wave JS: Title-Case "S2 Access Control" #20850

Z-Wave JS: Title-Case "S2 Access Control" #20850

AlCalzone commented May 22, 2024 •

edited by coderabbitai bot

Loading

matthiasdebaat commented May 22, 2024

AlCalzone commented May 22, 2024 •

edited

Loading

piitaya commented May 22, 2024

AlCalzone commented May 22, 2024

coderabbitai bot commented May 24, 2024 •

edited

Loading

Walkthrough

Changes

Review Settings

AST-based Instructions

Community-driven AST-based Rules

New Static Analysis Tools

Tone Settings

Revamped Settings Page

Miscellaneous

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

Z-Wave JS: Title-Case "S2 Access Control" #20850

Z-Wave JS: Title-Case "S2 Access Control" #20850

Conversation

AlCalzone commented May 22, 2024 • edited by coderabbitai bot Loading

Breaking change

Proposed change

Type of change

Example configuration

Additional information

Checklist

Summary by CodeRabbit

matthiasdebaat commented May 22, 2024

AlCalzone commented May 22, 2024 • edited Loading

piitaya commented May 22, 2024

AlCalzone commented May 22, 2024

coderabbitai bot commented May 24, 2024 • edited Loading

Walkthrough

Changes

Review Settings

AST-based Instructions

Community-driven AST-based Rules

New Static Analysis Tools

Tone Settings

Revamped Settings Page

Miscellaneous

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

AlCalzone commented May 22, 2024 •

edited by coderabbitai bot

Loading

AlCalzone commented May 22, 2024 •

edited

Loading

coderabbitai bot commented May 24, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)